<!--
 Copyright 2009 Arne Halvorsen (arne.halvorsen@gmail.com)

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.


 Project page: http://code.google.com/p/webfg/


 091208 - aha42 - Created.
 091218 - aha42 - Changed text and forms since now user name and collection
                  name on non default gallery collection can be it's name.
-->
<!-- Author: Arne Halvorsen (aha42) -->
<html>
  
  <head>
    
    <style type="text/css">
    
      body 
      {
        width: 70%;
        font-size: 100%;
        font-family: 'Verdana', Geneva, sans-serif;
        background-color:white;
      }
      
      h1
      {
        text-align: center;
      }
   
    </style>
     
  </head>
  
  <body>
    <h1>Web Flickr Gallery</h1>
    
    <h2>Introduction</h2>
    
    <p>
      Web Flickr Gallery is a Web App that let you use Flickr to define a 
      minimalistic styled web gallery of selected photos in your stream. 
    </p>
    
    <h2>Defining a gallery</h2>

    <p>
      The URL to your gallery can be:
    </p>

    <code>
      http://webfgallery.appspot.com/wfg?user=<b>id</b>
    </code>

    <p>
      Where <code><b>user</b></code> is your Flickr user name.
    </p>
    
    <p>
      The application will search for a <i>collection</i> in your public Flickr 
      content containing <i>photo set</i>s. On the Gallery front page there will
      be links to <i>exhibitions</i> of photos in the sets. 
    </p>
    
    <p>
      If you have made a collection with the name 'Gallery' containing at least
      one set with photos you can try visiting your gallery entering your Flickr
      user id in the form below and submit. 
    </p>
    
    <form action='webfg' method='get'>
      User name: <input type='text' name='user' />
      <input type="submit" value="Submit" />
    </form>
    
    <p>
      If one do not want to have a collection named 'Gallery' one can use an URL
      of the form:
    </p>
    
    <code>
      http://webfgallery.appspot.com/wfg?nsid=<b>id</b>&gid=<b>id</b>
    </code>
    
    <p>
      Where <b>gid</b> can is the name of the collection.
    </p>
    
    <form action='webfg' method='get'>
      User name: <input type='text' name='user' />
      Collection: <input type='text' name='gid' />
      <input type="submit" value="Submit" />
    </form>
    
    <p>
      A photo set names <code>profile</code> in your collection used for the
      gallery is special: photos here are not shown in separate 'exhibitions'
      but are randomly selected to appear on the gallery's front page.
    </p>
    
    <p>
      The gallery service are using some tags of the form 
      <code>webfg.name=value</code> as explained in the table below:
    </p>
    
    <table border='1'>
      <tr><th>Tag</th><th>Description</th><th>Default value</th></tr>
      <tr>
        <td><code>webfg.license=...</code></td>
        <td>
          Value is license text put on pages. If found on a photo in the 
          profile set applies to all pages and if found on a photo in the 
          'exhibition' sets applies for that photo's page in the gallery.
        </td>
        <td>
          All rights reserved.
        </td>
      </tr>
      
      <tr>
        <td><code>webfg.about=...</code></td>
        <td>
          If given on one of the photos in the <code>profile</code> set value
          text becomes link to photographer's Flickr profile page on gallery's 
          front page.
        </td>
        <td>
          None, it is optional to make this link.
        </td>
      </tr>
      
      <tr>
        <td><code>webfg.contact=...</code></td>
        <td>
          Value is taken to be a e-mail address and if present a link to send a
          email to photographer is created on gallery's front page.
        </td>
        <td>
          None, it is optional to make this link.
        </td>
      </tr>
      
      <tr>  
        <td><code>webfg.gallery-title=...</code></td>
        <td>
          The title on gallery's front page. Must be given on one of the photos
          in the <code>profile</code> set.
        </td>
        <td>
          Gallery collection's title.
        </td>
      </tr>
      
      <tr>
        <td><code>webfg.title=...</code></td>
        <td>
          If found on a photo in one of the 'exhibition' sets will be the title
          for that picture in the gallery.
        </td>
        <td>
          The photo's title.
        </td>
      </tr>
      
      <tr>
        <td><code>webfg.size=...</code></td>
        <td>
          If found on a photo in one of the 'exhibition' sets tells the size the
          photo should be displayed at in the gallery. Legal values are 
          <code>s</code> for small, <code>m</code> for medium and <code>l</code>
          for large.
        </td>
        <td>
          <code>m</code>
        </td>
      </tr>
    </table>
    
    <br/>
    <a href='/colophon.html'>Colophon</a>
    
  </body>
  
</html>
